Improve README: explain the tool, document all CLI flags, add improvement roadmap#4
Merged
Merged
Conversation
…ent opportunities Co-authored-by: johnsirmon <11774402+johnsirmon@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update README to improve clarity and explanation
Improve README: explain the tool, document all CLI flags, add improvement roadmap
Feb 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README lacked context about what HEIC is, how iCloud exports produce these zips, and was missing documentation for several CLI flags entirely.
Changes
Content additions
Backgroundsection explaining HEIC format, why it's not universally compatible, and the iCloud.com export workflow that produces the*icloud*.zipinput filesCLI documentation
--zip-patternand--verbosewere previously undocumented--extract-diris a temporary directory that is auto-deleted after conversionDeveloper experience
pip install -e .dev install instructions (was absent)heic-converterinstalled console script usage example__main__.pyadded to project structure listing (was missing)Opportunities to Improve section
Nine actionable enhancement ideas: output format flag (
--format jpeg), parallel conversion viaThreadPoolExecutor, per-file error handling instead of aborting the batch,tqdmprogress bar, EXIF metadata preservation, duplicate detection/skip, configurable--icloud-prefix, dry-run mode, and JPEG input support.Badges
CI status, Python version, and license shields added to the header.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.